Vin File Export

Introduction

This document provides details on the VIN file export process applicable to below manufacturers FNP provider.

Applicable Manufacturers

• KIA

File Format and Naming Convention

• Format: Compressed ZIP file containing a CSV file.
• File Naming Convention:
  vin_list_for_{fnpProviderName}-{ddMMyyyy}.csv

Download Sample Exported VIN File.

Prerequisites

Ensure the following conditions are met before initiating the export:

1. The lease company must be integrated with fnpProvider and have the integration enabled.
2. The vehicle must be registered under the manufacturer.
3. The receivedMenuPrice Typesense field must be false or undefined, indicating no menu price has been previously imported for this VIN.

File Structure and Fields

The exported file follows a structured format with the fields below:

Field Position	Field Name	Description	Example
A	VIN	Vehicle Identification Number	0TW5K9A1TEV1DD085

Setup Requirements

The following configurations are required:

• Job Name: generateVINListForFnp[Manufacturer Name]
  (Example: generateVINListForFnpKia)
• Region: europe-west2
• Frequency: 30 23 * * *
• Time Zone: GMT London
• Topic: projects/[env]/topics/generateVINListForFnpProvider

Message Body Format

The request must be a JSON object containing these parameters:

Parameter	Description	Example
sourceFolderName	Defines the folder where the exported file is stored.	fnp-exports
fnpProviderName	Specifies the manufacturer associated with the VIN list.	KIA

Debugging Steps

If issues arise, follow these debugging steps:

1. Verify that the stock has been successfully imported.
2. Ensure the stock's manufacturer matches the fnpProvider manufacturer.
3. Confirm that the lease company is integrated with fnpProvider and has the necessary integration enabled.
4. Check that receivedMenuPrice is set to false in Typesense. If true, verify whether a menu price was previously imported.

Export Process

Using Cloud Scheduler

1. Navigate to Cloud Scheduler.
2. Execute the generateVINListForFnp[Manufacturer Name] job.
   (Example: generateVINListForFnpKia.)
3. Once the export is complete, the file is stored in the cloud bucket.
4. Another Cloud Scheduler job is triggered to upload the exported file via SFTP.

Testing Guidelines

• The exported file must include all VINs that meet the prerequisites.
• The file must not contain a header.

Status: Accepted
Category: Protected
Authored By: Jeyakumar Arunagiri on Feb 13, 2025

Revisions